Move documentation to inline comments: GtkRange

diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 83f383bdecad32c9cd8c3a458f063e5c9bc7ffc3..f298ba457f56d65d7003e9b51f13ed8f83ff94b8 100644 (file)
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -9,6 +9,7 @@ gtkpagesetupunixdialog.sgml
 gtkprinter.sgml
 gtkradioaction.sgml
 gtkradiobutton.sgml
+gtkrange.sgml
 gtkrecentaction.sgml
 gtkrecentchooser.sgml
 gtkrecentchooserwidget.sgml

diff --git a/docs/reference/gtk/tmpl/gtkrange.sgml b/docs/reference/gtk/tmpl/gtkrange.sgml
deleted file mode 100644 (file)
index d64ef08..0000000
--- a/docs/reference/gtk/tmpl/gtkrange.sgml
+++ /dev/null
@@ -1,424 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkRange
-
-<!-- ##### SECTION Short_Description ##### -->
-Base class for widgets which visualize an adjustment
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-#GtkRange is the common base class for widgets which visualize an
-adjustment, e.g scales or scrollbars. 
-</para>
-<para>
-Apart from signals for monitoring the parameters of the adjustment, 
-GtkRange provides properties and methods for influencing the sensitivity
-of the "steppers". It also provides properties and methods for setting a 
-"fill level" on range widgets. See gtk_range_set_fill_level().
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkRange ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SIGNAL GtkRange::adjust-bounds ##### -->
-<para>
-
-</para>
-
-@range: the object which received the signal.
-@arg1: 
-
-<!-- ##### SIGNAL GtkRange::change-value ##### -->
-<para>
-
-</para>
-
-@range: the object which received the signal.
-@arg1: 
-@arg2: 
-@Returns: 
-
-<!-- ##### SIGNAL GtkRange::move-slider ##### -->
-<para>
-
-</para>
-
-@range: 
-@step: 
-
-<!-- ##### SIGNAL GtkRange::value-changed ##### -->
-<para>
-
-</para>
-
-@range: 
-
-<!-- ##### ARG GtkRange:adjustment ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:fill-level ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:inverted ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:lower-stepper-sensitivity ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:restrict-to-fill-level ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:show-fill-level ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:update-policy ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:upper-stepper-sensitivity ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:activate-slider ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:arrow-displacement-x ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:arrow-displacement-y ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:arrow-scaling ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:slider-width ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:stepper-size ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:stepper-spacing ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:trough-border ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:trough-side-details ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkRange:trough-under-steppers ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_range_get_fill_level ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_get_restrict_to_fill_level ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_get_show_fill_level ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_set_fill_level ##### -->
-<para>
-
-</para>
-
-@range: 
-@fill_level: 
-
-
-<!-- ##### FUNCTION gtk_range_set_restrict_to_fill_level ##### -->
-<para>
-
-</para>
-
-@range: 
-@restrict_to_fill_level: 
-
-
-<!-- ##### FUNCTION gtk_range_set_show_fill_level ##### -->
-<para>
-
-</para>
-
-@range: 
-@show_fill_level: 
-
-
-<!-- ##### FUNCTION gtk_range_get_adjustment ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_set_update_policy ##### -->
-<para>
-
-</para>
-
-@range: 
-@policy: 
-
-
-<!-- ##### FUNCTION gtk_range_set_adjustment ##### -->
-<para>
-
-</para>
-
-@range: 
-@adjustment: 
-
-
-<!-- ##### FUNCTION gtk_range_get_inverted ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_set_inverted ##### -->
-<para>
-
-</para>
-
-@range: 
-@setting: 
-
-
-<!-- ##### FUNCTION gtk_range_get_update_policy ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_get_value ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_set_increments ##### -->
-<para>
-
-</para>
-
-@range: 
-@step: 
-@page: 
-
-
-<!-- ##### FUNCTION gtk_range_set_range ##### -->
-<para>
-
-</para>
-
-@range: 
-@min: 
-@max: 
-
-
-<!-- ##### FUNCTION gtk_range_set_value ##### -->
-<para>
-
-</para>
-
-@range: 
-@value: 
-
-
-<!-- ##### ENUM GtkSensitivityType ##### -->
-<para>
-Determines how GTK+ handles the sensitivity of stepper arrows
-at the end of range widgets.
-</para>
-
-@GTK_SENSITIVITY_AUTO: The arrow is made insensitive if the
-   thumb is at the end
-@GTK_SENSITIVITY_ON: The arrow is always sensitive
-@GTK_SENSITIVITY_OFF: The arrow is always insensitive
-
-<!-- ##### FUNCTION gtk_range_set_lower_stepper_sensitivity ##### -->
-<para>
-
-</para>
-
-@range: 
-@sensitivity: 
-
-
-<!-- ##### FUNCTION gtk_range_get_lower_stepper_sensitivity ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_set_upper_stepper_sensitivity ##### -->
-<para>
-
-</para>
-
-@range: 
-@sensitivity: 
-
-
-<!-- ##### FUNCTION gtk_range_get_upper_stepper_sensitivity ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_get_flippable ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_set_flippable ##### -->
-<para>
-
-</para>
-
-@range: 
-@flippable: 
-
-
-<!-- ##### FUNCTION gtk_range_get_min_slider_size ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_get_range_rect ##### -->
-<para>
-
-</para>
-
-@range: 
-@range_rect: 
-
-
-<!-- ##### FUNCTION gtk_range_get_slider_range ##### -->
-<para>
-
-</para>
-
-@range: 
-@slider_start: 
-@slider_end: 
-
-
-<!-- ##### FUNCTION gtk_range_get_slider_size_fixed ##### -->
-<para>
-
-</para>
-
-@range: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_range_set_min_slider_size ##### -->
-<para>
-
-</para>
-
-@range: 
-@min_size: 
-
-
-<!-- ##### FUNCTION gtk_range_set_slider_size_fixed ##### -->
-<para>
-
-</para>
-
-@range: 
-@size_fixed: 
-
-

diff --git a/gtk/gtkenums.h b/gtk/gtkenums.h
index 2bb021e7a8c47ab490d230439ac48af5060f0f8e..6d9b491204540f3f3d6799683ea137d007740737 100644 (file)
--- a/gtk/gtkenums.h
+++ b/gtk/gtkenums.h
@@ -140,7 +140,16 @@ typedef enum
   GTK_ICON_SIZE_DIALOG
 } GtkIconSize;
 
-/* automatic sensitivity */
+/**
+ * GtkSensitivityType:
+ * @GTK_SENSITIVITY_AUTO: The arrow is made insensitive if the
+ *   thumb is at the end
+ * @GTK_SENSITIVITY_ON: The arrow is always sensitive
+ * @GTK_SENSITIVITY_OFF: The arrow is always insensitive
+ *
+ * Determines how GTK+ handles the sensitivity of stepper arrows
+ * at the end of range widgets.
+ */
 typedef enum
 {
   GTK_SENSITIVITY_AUTO,

diff --git a/gtk/gtkrange.c b/gtk/gtkrange.c
index a4fcee42545d87ced76195bf76ce51604e1e0781..6d942197466b72ab23127225ef0b6c65aac562df 100644 (file)
--- a/gtk/gtkrange.c
+++ b/gtk/gtkrange.c
@@ -41,6 +41,22 @@
 #include "gtkintl.h"
 #include "gtkalias.h"
 
+
+/**
+ * SECTION:gtkrange
+ * @Short_description: Base class for widgets which visualize an adjustment
+ * @Title: GtkRange
+ *
+ * #GtkRange is the common base class for widgets which visualize an
+ * adjustment, e.g #GtkScale or #GtkScroolbar.
+ *
+ * Apart from signals for monitoring the parameters of the adjustment,
+ * #GtkRange provides properties and methods for influencing the sensitivity
+ * of the "steppers". It also provides properties and methods for setting a
+ * "fill level" on range widgets. See gtk_range_set_fill_level().
+ */
+
+
 #define SCROLL_DELAY_FACTOR 5    /* Scroll repeat multiplier */
 #define UPDATE_DELAY        300  /* Delay for queued update */
 
@@ -272,7 +288,7 @@ gtk_range_class_init (GtkRangeClass *class)
 
   /**
    * GtkRange::value-changed:
-   * @range: the #GtkRange
+   * @range: the #GtkRange that received the signal
    *
    * Emitted when the range value changes.
    */
@@ -284,7 +300,12 @@ gtk_range_class_init (GtkRangeClass *class)
                   NULL, NULL,
                   _gtk_marshal_VOID__VOID,
                   G_TYPE_NONE, 0);
-  
+
+  /**
+   * GtkRange::adjust-bounds:
+   * @range: the #GtkRange that received the signal
+   * @value: the value before we clamp
+   */
   signals[ADJUST_BOUNDS] =
     g_signal_new (I_("adjust-bounds"),
                   G_TYPE_FROM_CLASS (gobject_class),
@@ -297,7 +318,7 @@ gtk_range_class_init (GtkRangeClass *class)
   
   /**
    * GtkRange::move-slider:
-   * @range: the #GtkRange
+   * @range: the #GtkRange that received the signal
    * @step: how to move the slider
    *
    * Virtual function that moves the slider. Used for keybindings.
@@ -314,7 +335,7 @@ gtk_range_class_init (GtkRangeClass *class)
 
   /**
    * GtkRange::change-value:
-   * @range: the range that received the signal
+   * @range: the #GtkRange that received the signal
    * @scroll: the type of scroll action that was performed
    * @value: the new value resulting from the scroll action
    * @returns: %TRUE to prevent other handlers from being invoked for the